<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Reference Provider</title>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/488/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/505/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Reference Provider</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.workbench.texteditor.quickdiffReferenceProvider<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.0
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Allows contributors to add reference providers for the quick diff display.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.referenceprovider">referenceprovider</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.referenceprovider">referenceprovider</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST referenceprovider</p>
<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">label&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">default&nbsp;(true | false) </p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
The definition of a reference provider for the quick diff display.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - the class of the reference provider, which must implement <code>org.eclipse.ui.texteditor.quickdiff.IQuickDiffReferenceProvider</code></li>
<li><b>label</b> - the display label for the provider, which will show up in the menu that allows the user to set the quick diff reference to this provider</li>
<li><b>id</b> - A string uniquely identifying this reference provider.</li>
<li><i style="color: red;">Deprecated</i> <b>default</b> - if this flag is set to <code>true</code>, this reference provider will be installed per default the first time quick diff is enabled for a document. If multiple providers are installed with the flag set are encountered, the first one is taken.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a reference provider definition. It contributes a provider that uses the version of a document saved on disk as a reference.

<p>
<pre class="Example"><span class="code SchemaTag">
 &lt;extension point=</span><span class="code SchemaCstring">&quot;quickdiff.referenceprovider&quot;</span><span class="code SchemaTag">&gt;
  &lt;referenceprovider
   id=</span><span class="code SchemaCstring">&quot;default&quot;</span><span class="code SchemaTag">
   name=</span><span class="code SchemaCstring">&quot;%LastSavedProvider.name&quot;</span><span class="code SchemaTag">
   label=</span><span class="code SchemaCstring">&quot;%quickdiff.referenceprovider.label&quot;</span><span class="code SchemaTag">
   class=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.internal.editors.quickdiff.providers.LastSaveReferenceProvider&quot;</span><span class="code SchemaTag">&gt;
  &lt;/referenceprovider&gt;
 &lt;/extension&gt;
</span></pre>
</p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>There is no additional API for managing reference providers.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The <code>org.eclipse.ui.editors</code> plugin contributes <code>LastSaveReferenceProvider</code>. See its implementation as an example.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2001, 2005 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

</p>
</BODY>
</HTML>
